<?php
// +----------------------------------------------------------------------
// | ThinkPHP [ WE CAN DO IT JUST THINK ]
// +----------------------------------------------------------------------
// | Copyright (c) 2006~2019 http://thinkphp.cn All rights reserved.
// +----------------------------------------------------------------------
// | Licensed ( http://www.apache.org/licenses/LICENSE-2.0 )
// +----------------------------------------------------------------------
// | Author: liu21st <liu21st@gmail.com>
// +----------------------------------------------------------------------
declare (strict_types = 1); //声明代码的执行指令为开启严格模式,主要为参数类型为严格模式,方便常驻内存

namespace think;

use ArrayAccess;


// +----------------------------------------------------------------------
// |
// | (愿景,目的) 名称:Env管理类(环境变量)
// | 功能: 
// | (心智)原则:单一职责原则/里氏替换原则/依赖倒置原则/接口隔离原则/迪米特法则/开闭原则
// | 结构组成: 
// | (形式) 类模式: 接口继承
// | (模式)模式类型: 
// | (模式)设计模式: 
// | 产生事件:
// | Understand:Cluster Call Butterfly
// |
// | ---------分析--------------
// | 需求的产生 想法
// | 道: <用户-客户立场>|<人的视角>(欲望)
// | 愿景:
// | 目的:
// |
// | =============================
// | 需求的分解--架构-偏商业架构/业务角度
// | 法: <组织内部立场>|<人的视角>
// | 目的:
// | 心智:遵循思维模式,原则
// | (系统)功能:
// | 结构:
// | 协议:
// |
// | =============================
// | 不同环境下的适应性,范围越大越优雅,TP 在复杂应用环境下对领域边界的处理不够,
// | 照成项目文件的复杂错乱,不易迭代,是导致被鄙视的根源
// | 需求点规划/-架构-技术架构,开发上这块是核心 做法
// | 术:<组织内部立场>|<物的视角>
// | 用户/客户立场:(人的视角)(结果)感知
// | 形式:
// |
// | 组织内部立场:(物的视角)(设定)系统思考.逻辑思考
// | 结构:
// |
// | =============================
// | 方案实施 执行 怎么用
// | 器:<物的视角>
// | (转换接口,把物和人联系起来)
// | 形式:
// |
// | (用户/客户立场|视角|(背后是结构)
// | 模式:
// |
// | (具体方法)
// | 事件:
// | -------------------------
// |
// | 知识点:
// | 继承类说明:
// | ArrayAccess 对象以数组形式来使用
// | 点评: 配置环境变量的各种管理
// |       一般 PHP 习惯性操作数组方式做参数,而且配置本身没什么对象操作的必要.这个类是框架自己的实现.
// |
// +----------------------------------------------------------------------


/**
 * Env管理类(环境变量)
 * @package think
 */
class Env implements ArrayAccess
{
    /**
     * 环境变量数据
     * @var array
     */
    protected $data = [];

    public function __construct()
    {
        // $_ENV 通过环境方式传递给当前脚本的变量的数组,PHP 自带的
        // 是一个包含服务器端环境变量的数组。它是PHP中一个超级全局变量
        // $_ENV只是被动的接受服务器端的环境变量并把它们转换为数组元素
        // 注意,在 swoole 下 这个变量是否和 fpm 下相同
        // 先把系统内的数组先取过来
        $this->data = $_ENV;
    }

    /**
     * 读取环境变量定义文件
     * @depreacate 作用:逻辑/调度
     * @depreacate 调用级别:2 有上级调用也有下级调用
     * @access public
     * @param string $file 环境变量定义文件
     * @return void
     *
     */
    public function load(string $file): void
    {
        // 因为配置文件的问题.这个地方的 env 只能是 ini 形式
        $env = parse_ini_file($file, true) ?: [];
        $this->set($env);
    }

    /**
     * 获取环境变量值
     * @access public
     * @param string $name    环境变量名
     * @param mixed  $default 默认值
     * @return mixed
     */
    public function get(string $name = null, $default = null)
    {
        if (is_null($name)) {
            return $this->data;
        }

        $name = strtoupper(str_replace('.', '_', $name));

        if (isset($this->data[$name])) {
            return $this->data[$name];
        }

        return $this->getEnv($name, $default);
    }

    protected function getEnv(string $name, $default = null)
    {
        $result = getenv('PHP_' . $name);

        if (false === $result) {
            return $default;
        }

        if ('false' === $result) {
            $result = false;
        } elseif ('true' === $result) {
            $result = true;
        }

        if (!isset($this->data[$name])) {
            $this->data[$name] = $result;
        }

        return $result;
    }

    /**
     * 设置环境变量值
     * @depreacate 作用:实现/数据
     * @access public
     * @param string|array $env   环境变量
     * @param mixed        $value 值
     * @return void
     */
    public function set($env, $value = null): void
    {
        // 载入配置,进行必要的格式化,配置的内容会转化为大写,同时把.转换为_
        // 不断给data 增加新参数
        if (is_array($env)) {
            // 将数组的所有的键都转换为大写字母
            $env = array_change_key_case($env, CASE_UPPER);

            // 这个地方的配置 实际是可以载入 2 级 配置.如果是下级配置就是 $data[上级_下级]=内容 的形式
            foreach ($env as $key => $val) {
                if (is_array($val)) {
                    foreach ($val as $k => $v) {
                        $this->data[$key . '_' . strtoupper($k)] = $v;
                    }
                } else {
                    $this->data[$key] = $val;
                }
            }
        } else {
            $name = strtoupper(str_replace('.', '_', $env));

            $this->data[$name] = $value;
        }
    }

    /**
     * 检测是否存在环境变量
     * @access public
     * @param string $name 参数名
     * @return bool
     */
    public function has(string $name): bool
    {
        return !is_null($this->get($name));
    }

    /**
     * 设置环境变量
     * @access public
     * @param string $name  参数名
     * @param mixed  $value 值
     */
    public function __set(string $name, $value): void
    {
        $this->set($name, $value);
    }

    /**
     * 获取环境变量
     * @access public
     * @param string $name 参数名
     * @return mixed
     */
    public function __get(string $name)
    {
        return $this->get($name);
    }

    /**
     * 检测是否存在环境变量
     * @access public
     * @param string $name 参数名
     * @return bool
     */
    public function __isset(string $name): bool
    {
        return $this->has($name);
    }

    // ArrayAccess
    public function offsetSet($name, $value): void
    {
        $this->set($name, $value);
    }

    public function offsetExists($name): bool
    {
        return $this->__isset($name);
    }

    public function offsetUnset($name)
    {
        throw new Exception('not support: unset');
    }

    public function offsetGet($name)
    {
        return $this->get($name);
    }
}
